/*
 * Copyright (c) 2002 Boris Pruessmann and others. All rights reserved. This
 * program and the accompanying materials are made available under the terms of
 * the Common Public License v0.5 which accompanies this distribution, and is
 * available at http://www.eclipse.org/legal/cpl-v05.html
 * 
 * Contributors: Boris Pruessmann - Initial implementation.
 */
package net.sourceforge.perforce.core.api;

/**
 * This interface describes the result of a 'p4 submit' command.
 * 
 * @version $Revision: 488 $
 * @author <a href="mailto:bpruessmann@users.sourceforge.net">Boris
 *         Pruessmann</a>
 */
public interface ISubmitResult {
  //----------------------------------------------------------------------------
  // --------- Methods

  /**
   * Call this method to retrieve the depot filename of the submitted file.
   * 
   * @return the depot filename.
   */
  String getDepotFilename();

  /**
   * Call this method to retrieve the action that was performed on the file.
   * 
   * @return the performed action.
   */
  String getAction();

  /**
   * Checks whether the file was refreshed or not during the operation.
   * 
   * @return true if file was refreshed, false otherwise.
   */
  boolean isRefreshed();
}
